Skip to content

rest-api-spec: specify master_timeout default value #134525

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Sep 17, 2025
Merged

rest-api-spec: specify master_timeout default value #134525

merged 1 commit into from
Sep 17, 2025

Conversation

pquentin
Copy link
Member

@pquentin pquentin commented Sep 11, 2025 •
edited
Loading

When generating rest-api-spec from the Elasticsearch specification, I noticed many missing default values. This was automated using this Python script:

import json
import os

for path in os.listdir("api"):
    if path == "_common.json":
        continue
    api_name = path.removesuffix(".json")
    print(api_name)
    with open(f"api/{path}") as f:
        d = json.load(f)

    for name, data in d[api_name].get("params", {}).items():
        if name == "master_timeout":
            desc = data.pop("description")
            data["default"] = "30s"
            if desc:
                # make sure description comes after default
                data["description"] = desc

    with open(f"api/{path}", "w") as f:
        d = json.dump(d, f, indent=2)
        print("", file=f)  # end with an empty line

@pquentin pquentin added >non-issue :Core/Infra/REST API REST infrastructure and utilities auto-backport Automatically create backport pull requests when merged v9.2.0 v8.19.5 v9.1.5 v9.0.8 labels Sep 11, 2025
@elasticsearchmachine elasticsearchmachine added the Team:Core/Infra Meta label for core/infra team label Sep 11, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@pquentin pquentin mentioned this pull request Sep 11, 2025
Open
@pquentin pquentin removed the v9.0.8 label Sep 11, 2025
mosche
mosche approved these changes Sep 17, 2025
View reviewed changes
Copy link
Contributor

@mosche mosche left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@pquentin pquentin merged commit 3d8f78b into elastic:main Sep 17, 2025
34 checks passed
@elasticsearchmachine
Copy link
Collaborator

💔 Backport failed

Status Branch Result
❌ 8.19 Commit could not be cherrypicked due to conflicts
❌ 9.1 Commit could not be cherrypicked due to conflicts

You can use sqren/backport to manually backport by running backport --upstream elastic/elasticsearch --pr 134525

@pquentin pquentin mentioned this pull request Sep 17, 2025
Merged
pquentin added a commit to pquentin/elasticsearch that referenced this pull request Sep 17, 2025
@pquentin
rest-api-spec: specify master_timeout default value (elastic#134525)
9082852 
(cherry picked from commit 3d8f78b)

# Conflicts:
#	rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json
#	rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json
#	rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json
@pquentin
Copy link
Member Author

💔 Some backports could not be created

Status Branch Result
✅ 9.1
❌ 8.19 Conflict resolution was aborted by the user

Manual backport

To create the backport manually run:

backport --pr 134525

Questions ?

Please refer to the Backport tool documentation

pquentin added a commit to pquentin/elasticsearch that referenced this pull request Sep 17, 2025
@pquentin
[8.19] rest-api-spec: specify master_timeout default value (elastic#1…
422b95d 
…34525)
@pquentin pquentin mentioned this pull request Sep 17, 2025
Merged
mridula-s109 pushed a commit to mridula-s109/elasticsearch that referenced this pull request Sep 17, 2025
@pquentin @mridula-s109
rest-api-spec: specify master_timeout default value (elastic#134525)
055ba97
gmjehovich pushed a commit to gmjehovich/elasticsearch that referenced this pull request Sep 18, 2025
@pquentin @gmjehovich
rest-api-spec: specify master_timeout default value (elastic#134525)
8d22c91
pquentin added a commit that referenced this pull request Sep 19, 2025
@pquentin
[8.19] rest-api-spec: specify master_timeout default value (#134525) (#…
fa0bb4d 
…134889)
pquentin added a commit that referenced this pull request Oct 7, 2025
@pquentin
[9.1] rest-api-spec: specify master_timeout default value (#134525) (#…
6264cab 
…134876)

* rest-api-spec: specify master_timeout default value (#134525)

(cherry picked from commit 3d8f78b)

# Conflicts:
#	rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json
#	rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_data_stream_mappings.json
#	rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_data_stream_mappings.json

* Restore cluster_state description
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mosche mosche mosche approved these changes

Assignees

No one assigned

Labels

auto-backport Automatically create backport pull requests when merged backport pending :Core/Infra/REST API REST infrastructure and utilities >non-issue Team:Core/Infra Meta label for core/infra team v8.19.5 v9.1.5 v9.2.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pquentin @elasticsearchmachine @mosche